-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
TranslatorBatch.json
1293 lines (1293 loc) · 55.1 KB
/
TranslatorBatch.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"title": "Batch Document Translation Client",
"version": "v1.0-preview.1"
},
"paths": {
"/batches": {
"post": {
"tags": [
"Translation"
],
"summary": "Submit a batch document translation request to the translation service",
"description": "Submit a batch request to the document translation service.\r\n \r\nEach request can consists of multiple inputs.\r\nEach input will contains both a source and destination container for source and target language pair.\r\n \r\nThe prefix and suffix filter (if supplied) will be used to filter the folders.\r\nThe prefix will be applied to the subpath after the container name\r\n \r\nGlossaries / Translation memory can be supplied and will be applied when the document is being translated.\r\nIf the glossary is invalid or unreachable during translation time. An error will be indicated in the document status.\r\n \r\nIf the file with the same name already exists in the destination, it will be overwritten.\r\nTargetUrl for each target language needs to be unique.",
"operationId": "Translation_SubmitBatchRequest",
"consumes": [
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "request details",
"schema": {
"$ref": "#/definitions/BatchSubmissionRequest"
}
}
],
"responses": {
"202": {
"description": "Successful request and the batch request is created by the service. The header Operation-Location will indicate a status url with the operation id.",
"headers": {
"Operation-Location": {
"description": "Location of batch the operation",
"type": "string",
"format": ""
}
}
},
"400": {
"description": "Invalid request. Check input parameters",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 400120,\r\n \"error\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"401": {
"description": "Unauthorized. Please check your credentials",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Batch Submit": {
"$ref": "./examples/batch.json"
}
}
},
"get": {
"tags": [
"Translation"
],
"summary": "Returns the list of operations submitted and their summary status",
"description": "Returns the list of status of the translation batch operation.\r\nThe list will consist only of the batch request submitted by the user (based on their subscription)\r\n \r\nThe operation status are sorted by the operation Id\r\n \r\nIf the number of operations exceed our paging limit, server side paging will be used.\r\nPaginated responses will indicate a partial result by including a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nThe server will honor the values specified by the client; however, clients MUST be prepared to handle responses that contain a different page size or contain a continuation token.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. This will avoid the risk of the client making assumptions about the data returned.",
"operationId": "Translation_GetOperations",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "$top",
"description": "Take the $top entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first",
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100,
"minimum": 1
},
{
"in": "query",
"name": "$skip",
"description": "Skip the $skip entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first",
"type": "integer",
"format": "int32",
"default": 0,
"maximum": 2147483647,
"minimum": 0
}
],
"responses": {
"200": {
"description": "Successful request and returns the status of the all the operations",
"schema": {
"$ref": "#/definitions/BatchStatusResponse"
},
"headers": {
"Retry-After": {
"description": "Indicates how long to wait before making a new request.",
"type": "integer",
"format": "int32"
},
"ETag": {
"description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.",
"type": "string",
"format": ""
}
}
},
"400": {
"description": "Invalid request. Check input parameters",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 400120,\r\n \"error\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"401": {
"description": "Unauthorized. Please check your credentials",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Get status for batch operations": {
"$ref": "./examples/operations.json"
}
}
}
},
"/batches/{id}/documents/{documentId}": {
"get": {
"tags": [
"Translation"
],
"summary": "Returns the status of the specific document",
"description": "Returns the status of the translation of the document.",
"operationId": "Translation_GetDocumentStatus",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "Format - uuid. The batch id",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "path",
"name": "documentId",
"description": "Format - uuid. The document id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Successful request and it is accepted by the service. The operation details are returned",
"schema": {
"$ref": "#/definitions/DocumentStatusDetail"
},
"headers": {
"Retry-After": {
"description": "Indicates how long to wait before making a new request.",
"type": "integer",
"format": "int32"
},
"ETag": {
"description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.",
"type": "string",
"format": ""
}
}
},
"401": {
"description": "Unauthorized. Please check your credentials",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"404": {
"description": "Resource is not found",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 404000,\r\n \"error\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Get Document Status": {
"$ref": "./examples/document.json"
}
}
}
},
"/batches/{id}": {
"get": {
"tags": [
"Translation"
],
"summary": "Returns the status of the batch translation operation",
"description": "Returns the status of the translation batch operation.\r\nThe status will include the overall job status as well as a summary of the current progress of all the documents being translated.",
"operationId": "Translation_GetOperationStatus",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "Format - uuid. The operation id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Successful request and returns the status of the batch translation operation",
"schema": {
"$ref": "#/definitions/BatchStatusDetail"
},
"headers": {
"Retry-After": {
"description": "Indicates how long to wait before making a new request.",
"type": "integer",
"format": "int32"
},
"ETag": {
"description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.",
"type": "string",
"format": ""
}
}
},
"401": {
"description": "Unauthorized. Please check your credentials",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"404": {
"description": "Resource is not found",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 404000,\r\n \"error\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Get Batch Operation Status": {
"$ref": "./examples/operation.json"
}
}
},
"delete": {
"tags": [
"Translation"
],
"summary": "Cancel a currently processing or queued operation.",
"description": "Cancel a currently processing or queued operation.\r\nAn operation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.\r\nAll documents that have completed translation will not be cancelled and will be charged.\r\nAll pending documents will be cancelled if possible.",
"operationId": "Translation_CancelOperation",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "Format - uuid. The operation-id",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Cancel request has been submitted",
"schema": {
"$ref": "#/definitions/BatchStatusDetail"
}
},
"401": {
"description": "Unauthorized. Please check your credentials",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"404": {
"description": "Resource is not found",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 404000,\r\n \"error\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Cancel a batch operation example": {
"$ref": "./examples/cancel.json"
}
}
}
},
"/batches/{id}/documents": {
"get": {
"tags": [
"Translation"
],
"summary": "Returns the status of the documents of a translation batch operation",
"description": "Returns the status of the list of documents translation operation by a given operation id.\r\n \r\nThe documents are sorted by the document Id\r\n \r\nIf the number of documents exceed our paging limit, server side paging will be used.\r\nPaginated responses will indicate a partial result by including a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nThe server will honor the values specified by the client; however, clients MUST be prepared to handle responses that contain a different page size or contain a continuation token.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. This will avoid the risk of the client making assumptions about the data returned.",
"operationId": "Translation_GetOperationDocumentsStatus",
"produces": [
"application/json"
],
"parameters": [
{
"in": "path",
"name": "id",
"description": "Format - uuid. The operation id",
"required": true,
"type": "string",
"format": "uuid"
},
{
"in": "query",
"name": "$top",
"description": "Take the $top entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first",
"type": "integer",
"format": "int32",
"default": 50,
"maximum": 100,
"minimum": 1
},
{
"in": "query",
"name": "$skip",
"description": "Skip the $skip entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first",
"type": "integer",
"format": "int32",
"default": 0,
"maximum": 2147483647,
"minimum": 0
}
],
"responses": {
"200": {
"description": "Successful request and returns the status of the documents",
"schema": {
"$ref": "#/definitions/DocumentStatusResponse"
},
"headers": {
"Retry-After": {
"description": "Indicates how long to wait before making a new request.",
"type": "integer",
"format": "int32"
},
"ETag": {
"description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.",
"type": "string",
"format": ""
}
}
},
"400": {
"description": "Invalid request. Check input parameters",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 400120,\r\n \"error\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"401": {
"description": "Unauthorized. Please check your credentials",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"404": {
"description": "Resource is not found",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 404000,\r\n \"error\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Get Documents Status for the operation batch id": {
"$ref": "./examples/documents.json"
}
}
}
},
"/documents/formats": {
"get": {
"tags": [
"Translation"
],
"summary": "Returns the list of supported document formats",
"description": "The list of supported document formats supported by our service.\r\nThe list will include the common file extension used and supported as well as the content-type if using the upload API.",
"operationId": "Translation_GetDocumentFormats",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns the list of supported document file formats",
"schema": {
"$ref": "#/definitions/FileFormatListResult"
}
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Get Document Formats": {
"$ref": "./examples/format.json"
}
}
}
},
"/glossaries/formats": {
"get": {
"tags": [
"Translation"
],
"summary": "Returns the list of supported document formats",
"description": "The list of supported glossary formats supported by our service.\r\nThe list will include the common file extension used.",
"operationId": "Translation_GetGlossaryFormats",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns the list of supported glossary file formats",
"schema": {
"$ref": "#/definitions/FileFormatListResult"
}
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Get Glossary Formats": {
"$ref": "./examples/glossary.json"
}
}
}
},
"/storagesources": {
"get": {
"tags": [
"Translation"
],
"summary": "Returns the list of supported storage sources",
"description": "The list of storage sources supported by our service.",
"operationId": "Translation_GetDocumentStorageSource",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Successful request and returns the list of storage sources",
"schema": {
"$ref": "#/definitions/StorageSourceListResult"
}
},
"429": {
"description": "Too many requests",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
},
"503": {
"description": "Server temporary unavailable",
"schema": {
"$ref": "#/definitions/ErrorResponseV2"
},
"examples": {
"application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}"
},
"x-ms-error-response": true
}
},
"x-ms-examples": {
"Get Document Storage Sources": {
"$ref": "./examples/storage.json"
}
}
}
}
},
"definitions": {
"DocumentFilter": {
"type": "object",
"properties": {
"prefix": {
"description": "A case-sensitive prefix string to filter documents in the source path for translation. \r\nFor example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for translation.",
"type": "string",
"example": "FolderA"
},
"suffix": {
"description": "A case-sensitive suffix string to filter documents in the source path for translation. \r\nThis is most often use for file extensions",
"type": "string",
"example": ".txt"
}
}
},
"StorageSource": {
"description": "Storage Source",
"enum": [
"AzureBlob"
],
"type": "string"
},
"SourceInput": {
"description": "Source of the input documents",
"required": [
"sourceUrl"
],
"type": "object",
"properties": {
"sourceUrl": {
"description": "Location of the folder / container or single file with your documents",
"type": "string",
"example": "https://myblob.blob.core.windows.net/Container/"
},
"filter": {
"$ref": "#/definitions/DocumentFilter"
},
"language": {
"description": "Language code\r\nIf none is specified, we will perform auto detect on the document",
"type": "string",
"example": "en"
},
"storageSource": {
"$ref": "#/definitions/StorageSource"
}
}
},
"Glossary": {
"description": "Glossary / translation memory for the request",
"required": [
"glossaryUrl"
],
"type": "object",
"properties": {
"glossaryUrl": {
"description": "Location of the glossary. \r\nWe will use the file extension to extract the formatting if the format parameter is not supplied.\r\n\r\nIf the translation language pair is not present in the glossary, it will not be applied",
"type": "string",
"example": "https://myblob.blob.core.windows.net/Container/myglossary.tsv"
},
"format": {
"description": "Format",
"type": "string",
"example": "XLIFF"
},
"version": {
"description": "Version",
"type": "string",
"example": "2.0"
}
}
},
"TargetInput": {
"description": "Destination for the finished translated documents",
"required": [
"language",
"targetUrl"
],
"type": "object",
"properties": {
"targetUrl": {
"description": "Location of the folder / container with your documents",
"type": "string",
"example": "https://myblob.blob.core.windows.net/TargetUrl/"
},
"category": {
"description": "Category / custom system for translation request",
"type": "string",
"example": "general"
},
"language": {
"description": "Target Language",
"type": "string",
"example": "fr"
},
"glossaries": {
"description": "List of Glossary",
"type": "array",
"items": {
"$ref": "#/definitions/Glossary"
}
},
"storageSource": {
"$ref": "#/definitions/StorageSource"
}
}
},
"StorageInputType": {
"description": "Storage type of the input documents source string",
"enum": [
"Folder",
"File"
],
"type": "string"
},
"BatchRequest": {
"description": "Definition for the input batch translation request",
"required": [
"source",
"targets"
],
"type": "object",
"properties": {
"source": {
"$ref": "#/definitions/SourceInput"
},
"targets": {
"description": "Location of the destination for the output",
"type": "array",
"items": {
"$ref": "#/definitions/TargetInput"
}
},
"storageType": {
"$ref": "#/definitions/StorageInputType"
}
}
},
"BatchSubmissionRequest": {
"description": "Job submission batch request",
"required": [
"inputs"
],
"type": "object",
"properties": {
"inputs": {
"description": "The input list of documents or folders containing documents",
"type": "array",
"items": {
"$ref": "#/definitions/BatchRequest"
}
}
}
},
"Status": {
"description": "List of possible statuses for job or document",
"enum": [
"NotStarted",
"Running",
"Succeeded",
"Failed",
"Cancelled",
"Cancelling"
],
"type": "string"
},
"StatusSummary": {
"type": "object",
"properties": {
"total": {
"format": "int32",
"description": "Total count",
"type": "integer",
"example": 1
},
"failed": {
"format": "int32",
"description": "Failed count",
"type": "integer",
"example": 0
},
"success": {
"format": "int32",
"description": "Number of Success",
"type": "integer",
"example": 1
},
"inProgress": {
"format": "int32",
"description": "Number of in progress",
"type": "integer",
"example": 0
},
"notYetStarted": {
"format": "int32",
"description": "Count of not yet started",
"type": "integer",
"example": 0
},
"cancelled": {
"format": "int32",
"description": "Number of cancelled",
"type": "integer",
"example": 0
}